add slots, match_args, kw_only to dataclass func #252
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
add slots, match_args, kw_only to dataclass func
lovasoa
requested changes
Jan 24, 2024
Comment on lines
+192
to
+214
| args = { | ||
| "match_args": { | ||
| "error_message": "'match_args' argument is only available for python >= 3.10", | ||
| "default_value": True, | ||
| }, | ||
| "kw_only": { | ||
| "error_message": "'kw_only' argument is only available for python >= 3.10", | ||
| "default_value": False, | ||
| }, | ||
| "slots": { | ||
| "error_message": "'slots' argument is only available for python >= 3.10", | ||
| "default_value": False, | ||
| }, | ||
| } | ||
|
|
||
| for arg, arg_info in args.items(): | ||
| if locals()[arg] is not arg_info["default_value"]: | ||
| raise ValueError(arg_info["error_message"]) | ||
|
|
||
| # dataclass's typing doesn't expect it to be called as a function, so ignore type check | ||
| dc = dataclasses.dataclass( # type: ignore | ||
| _cls, repr=repr, eq=eq, order=order, unsafe_hash=unsafe_hash, frozen=frozen | ||
| ) |
There was a problem hiding this comment.
Why this ? Can't we just forward the arguments we got to the base dataclass implementation, and let it error if it wants to ?
There was a problem hiding this comment.
Agree. For the implementation can we not just do
def dataclass(
__cls: Optional[Type[_U]] = None,
*,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
**kwargs: bool,
) -> Union[Type[_U], Callable[[Type[_U]], Type[_U]]]:
dc = dataclasses.dataclass(**kwargs)
if not cls_frame:
current_frame = inspect.currentframe()
if current_frame:
cls_frame = current_frame.f_back
# Per https://docs.python.org/3/library/inspect.html#the-interpreter-stack
del current_frame
def decorate(cls: Type[_U]) -> Type[_U]:
return add_schema(dc(cls), base_schema, cls_frame=cls_frame)
if _cls is None:
return decorate
return decorate(cls)
dairiki
reviewed
Jan 24, 2024
There was a problem hiding this comment.
I've left a couple of comments here.
Also, see my review of #205 for more (albeit similar) comments.
https://github.com/lovasoa/marshmallow_dataclass/pull/205/files
| slots: bool = False, | ||
| base_schema: Optional[Type[marshmallow.Schema]] = None, | ||
| cls_frame: Optional[types.FrameType] = None, | ||
| ) -> Callable[[Type[_U]], Type[_U]]: |
There was a problem hiding this comment.
I feel these overloads should be conditional on python version. I.e. The prototypes should not declare unsupported options.
Since (I think) we want marshmallow_dataclass.dataclass to have the same signature as dataclasses.dataclass, we should probably just copy typeshed's interface definition for dataclass.
Comment on lines
+192
to
+214
| args = { | ||
| "match_args": { | ||
| "error_message": "'match_args' argument is only available for python >= 3.10", | ||
| "default_value": True, | ||
| }, | ||
| "kw_only": { | ||
| "error_message": "'kw_only' argument is only available for python >= 3.10", | ||
| "default_value": False, | ||
| }, | ||
| "slots": { | ||
| "error_message": "'slots' argument is only available for python >= 3.10", | ||
| "default_value": False, | ||
| }, | ||
| } | ||
|
|
||
| for arg, arg_info in args.items(): | ||
| if locals()[arg] is not arg_info["default_value"]: | ||
| raise ValueError(arg_info["error_message"]) | ||
|
|
||
| # dataclass's typing doesn't expect it to be called as a function, so ignore type check | ||
| dc = dataclasses.dataclass( # type: ignore | ||
| _cls, repr=repr, eq=eq, order=order, unsafe_hash=unsafe_hash, frozen=frozen | ||
| ) |
There was a problem hiding this comment.
Agree. For the implementation can we not just do
def dataclass(
__cls: Optional[Type[_U]] = None,
*,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
**kwargs: bool,
) -> Union[Type[_U], Callable[[Type[_U]], Type[_U]]]:
dc = dataclasses.dataclass(**kwargs)
if not cls_frame:
current_frame = inspect.currentframe()
if current_frame:
cls_frame = current_frame.f_back
# Per https://docs.python.org/3/library/inspect.html#the-interpreter-stack
del current_frame
def decorate(cls: Type[_U]) -> Type[_U]:
return add_schema(dc(cls), base_schema, cls_frame=cls_frame)
if _cls is None:
return decorate
return decorate(cls)
|
I tried to address some of the comments here in another PR: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is similar to an outstanding PR for two reasons: